/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.multipart;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;

import org.springframework.core.io.InputStreamSource;
import org.springframework.core.io.Resource;
import org.springframework.lang.Nullable;
import org.springframework.util.FileCopyUtils;

/**
 * A representation of an uploaded file received in a multipart request.
 *
 * <p>The file contents are either stored in memory or temporarily on disk.
 * In either case, the user is responsible for copying file contents to a
 * session-level or persistent store as and if desired. The temporary storage
 * will be cleared at the end of request processing.
 *
 * @author Juergen Hoeller
 * @author Trevor D. Cook
 * @since 29.09.2003
 * @see org.springframework.web.multipart.MultipartHttpServletRequest
 * @see org.springframework.web.multipart.MultipartResolver
 */
// 在多部分请求中收到的上传文件的表示。
// 文件内容要么存储在内存中，要么临时存储在磁盘上。
// 在任何一种情况下，如果需要，用户负责将文件内容复制到会话级别或持久存储。
// 临时存储将在请求处理结束时被清除。
public interface MultipartFile extends InputStreamSource {

	/**
	 * Return the name of the parameter in the multipart form.
	 * @return the name of the parameter (never {@code null} or empty)
	 */
	// 以多部分形式返回参数的名称。
	//
	// 返回：
	// 参数的名称（从不为null或为空）
	String getName();

	/**
	 * Return the original filename in the client's filesystem.
	 * <p>This may contain path information depending on the browser used,
	 * but it typically will not with any other than Opera.
	 * @return the original filename, or the empty String if no file has been chosen
	 * in the multipart form, or {@code null} if not defined or not available
	 * @see org.apache.commons.fileupload.FileItem#getName()
	 * @see org.springframework.web.multipart.commons.CommonsMultipartFile#setPreserveFilename
	 */
	// 返回客户端文件系统中的原始文件名。
	// 这可能包含路径信息，具体取决于所使用的浏览器，但通常不会包含在 Opera 之外的任何浏览器中。
	//
	// 返回：
	// 原始文件名，如果在多部分形式中没有选择文件，则为空字符串，如果未定义或不可用，则为null
	@Nullable
	String getOriginalFilename();

	/**
	 * Return the content type of the file.
	 * @return the content type, or {@code null} if not defined
	 * (or no file has been chosen in the multipart form)
	 */
	// 返回文件的内容类型。
	//
	// 回报：
	// 内容类型，如果未定义则为null （或在多部分表单中未选择文件）
	@Nullable
	String getContentType();

	/**
	 * Return whether the uploaded file is empty, that is, either no file has
	 * been chosen in the multipart form or the chosen file has no content.
	 */
	// 返回上传的文件是否为空，即multipart表单中没有选择文件或者选择的文件没有内容。
	boolean isEmpty();

	/**
	 * Return the size of the file in bytes.
	 * @return the size of the file, or 0 if empty
	 */
	// 返回文件的大小（以字节为单位）。
	//
	// 回报：
	// 文件的大小，如果为空，则为 0
	long getSize();

	/**
	 * Return the contents of the file as an array of bytes.
	 * @return the contents of the file as bytes, or an empty byte array if empty
	 * @throws IOException in case of access errors (if the temporary store fails)
	 */
	// 将文件的内容作为字节数组返回。
	//
	// 回报：
	// 文件内容为字节，如果为空则为空字节数组
	// 抛出：
	// IOException – 在访问错误的情况下（如果临时存储失败）
	byte[] getBytes() throws IOException;

	/**
	 * Return an InputStream to read the contents of the file from.
	 * <p>The user is responsible for closing the returned stream.
	 * @return the contents of the file as stream, or an empty stream if empty
	 * @throws IOException in case of access errors (if the temporary store fails)
	 */
	// 返回一个 InputStream 以从中读取文件的内容。
	// 用户负责关闭返回的流。
	//
	// 覆盖：
	// 接口InputStreamSource中的getInputStream
	// 回报：
	// 文件的内容作为流，如果为空，则为空流
	// 抛出：
	// IOException – 在访问错误的情况下（如果临时存储失败）
	@Override
	InputStream getInputStream() throws IOException;

	/**
	 * Return a Resource representation of this MultipartFile. This can be used
	 * as input to the {@code RestTemplate} or the {@code WebClient} to expose
	 * content length and the filename along with the InputStream.
	 * @return this MultipartFile adapted to the Resource contract
	 * @since 5.1
	 */
	// 返回此 MultipartFile 的资源表示。这可以用作RestTemplate或WebClient的输入，以公开内容长度和文件名以及 InputStream。
	//
	// 回报：
	// 这个 MultipartFile 适应了 Resource 合约
	default Resource getResource() {
		return new MultipartFileResource(this);
	}

	/**
	 * Transfer the received file to the given destination file.
	 * <p>This may either move the file in the filesystem, copy the file in the
	 * filesystem, or save memory-held contents to the destination file. If the
	 * destination file already exists, it will be deleted first.
	 * <p>If the target file has been moved in the filesystem, this operation
	 * cannot be invoked again afterwards. Therefore, call this method just once
	 * in order to work with any storage mechanism.
	 * <p><b>NOTE:</b> Depending on the underlying provider, temporary storage
	 * may be container-dependent, including the base directory for relative
	 * destinations specified here (e.g. with Servlet 3.0 multipart handling).
	 * For absolute destinations, the target file may get renamed/moved from its
	 * temporary location or newly copied, even if a temporary copy already exists.
	 * @param dest the destination file (typically absolute)
	 * @throws IOException in case of reading or writing errors
	 * @throws IllegalStateException if the file has already been moved
	 * in the filesystem and is not available anymore for another transfer
	 * @see org.apache.commons.fileupload.FileItem#write(File)
	 * @see javax.servlet.http.Part#write(String)
	 */
	// 将接收到的文件传输到给定的目标文件。
	// 这可以移动文件系统中的文件，复制文件系统中的文件，或者将内存保存的内容保存到目标文件。如果目标文件已经存在，则首先将其删除。
	// 如果目标文件已在文件系统中移动，则以后无法再次调用此操作。因此，只需调用一次此方法即可使用任何存储机制。
	// 注意：根据底层提供者，临时存储可能依赖于容器，包括此处指定的相对目标的基本目录（例如，使用 Servlet 3.0 多部分处理）。对于绝对目标，目标文件可能会从其临时位置重命名/移动或新复制，即使临时副本已经存在。
	//
	// 参数：
	// dest – 目标文件（通常是绝对文件）
	// 抛出：
	// IOException – 在读取或写入错误的情况下
	// IllegalStateException – 如果文件已经在文件系统中移动并且不再可用于另一次传输
	void transferTo(File dest) throws IOException, IllegalStateException;

	/**
	 * Transfer the received file to the given destination file.
	 * <p>The default implementation simply copies the file input stream.
	 * @since 5.1
	 * @see #getInputStream()
	 * @see #transferTo(File)
 	 */
	// 将接收到的文件传输到给定的目标文件。
	// 默认实现只是简单地复制文件输入流。
	default void transferTo(Path dest) throws IOException, IllegalStateException {
		FileCopyUtils.copy(getInputStream(), Files.newOutputStream(dest));
	}

}
